/*
 *
 *      Copyright (c) 2018-2025, lengleng All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  Redistributions in binary form must reproduce the above copyright
 *  notice, this list of conditions and the following disclaimer in the
 *  documentation and/or other materials provided with the distribution.
 *  Neither the name of the pig4cloud.com developer nor the names of its
 *  contributors may be used to endorse or promote products derived from
 *  this software without specific prior written permission.
 *  Author: lengleng (wangiegie@gmail.com)
 *
 */

package com.pig4cloud.pig.admin.api.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.fasterxml.jackson.annotation.JsonIgnore;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;

import java.io.Serializable;
import java.time.LocalDateTime;

/**
 * 用户表实体类
 * <p>
 * 系统用户信息管理，包含用户基本信息、认证信息和第三方登录信息。
 * 支持多种登录方式：用户名密码、手机号、微信、QQ等
 * </p>
 *
 * @author lengleng
 * @since 2017-10-29
 */
@Data
@Schema(description = "用户")
public class SysUser implements Serializable {

	private static final long serialVersionUID = 1L;

	/**
	 * 主键ID
	 * <p>
	 * 采用雪花算法生成的唯一标识
	 * </p>
	 */
	@TableId(value = "user_id", type = IdType.ASSIGN_ID)
	@Schema(description = "主键id")
	private Long userId;

	/**
	 * 用户名
	 * <p>
	 * 登录用户名，在系统中唯一，不可重复
	 * </p>
	 */
	@Schema(description = "用户名")
	private String username;

	/**
	 * 密码
	 * <p>
	 * 用户登录密码，采用BCrypt加密存储
	 * </p>
	 */
	@Schema(description = "密码")
	private String password;

	/**
	 * 随机盐
	 * <p>
	 * 密码加密时的随机盐值，增强密码安全性。
	 * 使用@JsonIgnore避免在JSON序列化时暴露
	 * </p>
	 */
	@JsonIgnore
	@Schema(description = "随机盐")
	private String salt;

	/**
	 * 创建人
	 */
	@TableField(fill = FieldFill.INSERT)
	@Schema(description = "创建人")
	private String createBy;

	/**
	 * 修改人
	 */
	@TableField(fill = FieldFill.UPDATE)
	@Schema(description = "修改人")
	private String updateBy;

	/**
	 * 创建时间
	 */
	@TableField(fill = FieldFill.INSERT)
	@Schema(description = "创建时间")
	private LocalDateTime createTime;

	/**
	 * 修改时间
	 */
	@TableField(fill = FieldFill.UPDATE)
	@Schema(description = "修改时间")
	private LocalDateTime updateTime;

	/**
	 * 删除标记
	 * <p>
	 * 逻辑删除标记，0-正常，1-已删除
	 * </p>
	 */
	@TableLogic
	@TableField(fill = FieldFill.INSERT)
	@Schema(description = "删除标记,1:已删除,0:正常")
	private String delFlag;

	/**
	 * 锁定标记
	 * <p>
	 * 用户账号锁定状态，0-正常，9-锁定。
	 * 锁定后用户无法登录系统
	 * </p>
	 */
	@Schema(description = "锁定标记")
	private String lockFlag;

	/**
	 * 手机号
	 * <p>
	 * 用户手机号码，可用于手机号登录和短信验证
	 * </p>
	 */
	@Schema(description = "手机号")
	private String phone;

	/**
	 * 头像
	 * <p>
	 * 用户头像图片地址，可以是本地文件路径或者网络地址
	 * </p>
	 */
	@Schema(description = "头像地址")
	private String avatar;

	/**
	 * 部门ID
	 * <p>
	 * 用户所属部门，关联sys_dept表的dept_id
	 * </p>
	 */
	@Schema(description = "用户所属部门id")
	private Long deptId;

	/**
	 * 微信openid
	 * <p>
	 * 微信公众号开放平台用户唯一标识，用于微信登录
	 * </p>
	 */
	@Schema(description = "微信openid")
	private String wxOpenid;

	/**
	 * 微信小程序openId
	 * <p>
	 * 微信小程序用户唯一标识，用于小程序登录
	 * </p>
	 */
	@Schema(description = "微信小程序openid")
	private String miniOpenid;

	/**
	 * QQ openid
	 * <p>
	 * QQ互联开放平台用户唯一标识，用于QQ登录
	 * </p>
	 */
	@Schema(description = "QQ openid")
	private String qqOpenid;

	/**
	 * 码云唯一标识
	 * <p>
	 * Gitee开放平台用户唯一标识，用于Gitee登录
	 * </p>
	 */
	@Schema(description = "码云唯一标识")
	private String giteeLogin;

	/**
	 * 开源中国唯一标识
	 * <p>
	 * OSChina开放平台用户唯一标识，用于OSChina登录
	 * </p>
	 */
	@Schema(description = "开源中国唯一标识")
	private String oscId;

	/**
	 * 昵称
	 * <p>
	 * 用户昵称，用于展示和社交场景
	 * </p>
	 */
	@Schema(description = "昵称")
	private String nickname;

	/**
	 * 姓名
	 * <p>
	 * 用户真实姓名，用于实名认证和正式场合
	 * </p>
	 */
	@Schema(description = "姓名")
	private String name;

	/**
	 * 邮箱
	 * <p>
	 * 用户邮箱地址，用于邮箱验证和消息通知
	 * </p>
	 */
	@Schema(description = "邮箱")
	private String email;

}
